Package com.cisco.pt.ipc.sim.impl
Class AsaObjectImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.AsaObjectImpl
Information provided by the PKI file:
\class CAsaObject
\brief CAsaObject is the asa object storage manager class that is used to store and retrieve asa object.
\example network().getDevice("Router0").getObjectManager()->getObjectByName("objectName")
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionAsaObjectImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddReferenceObject(String reference) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:booleanInformation provided by the PKI file:voidremoveReferenceObject(String reference) Information provided by the PKI file:voidsetDescription(String description) Information provided by the PKI file:voidsetObjectName(String objectName) Information provided by the PKI file:toString()Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
AsaObjectImpl
public AsaObjectImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getObjectName
Information provided by the PKI file:
\brief Return the asa object name \return string, value is the asa object name.- Specified by:
getObjectNamein interfaceAsaObject- Returns:
- String Returns a String
-
setObjectName
Information provided by the PKI file:
\brief Return the asa object name \param objectName, value is the name to give the object.- Specified by:
setObjectNamein interfaceAsaObject- Parameters:
objectName- Takes in a parameter of objectName
-
getObjectType
Information provided by the PKI file:
\brief Return the asa object type type - asa object type, values: eNetwork = 0, eService = 1, eGroupService = 2, eGroupServiceTcp = 3, eGroupServiceUdp = 4, eGroupServiceTcpUdp = 5, eGroupNetwork = 6, eWebvpn = 7 \return ObjectType, value is the asa object type.- Specified by:
getObjectTypein interfaceAsaObject- Returns:
- ObjectType Returns a ObjectType
-
getDescription
Information provided by the PKI file:
\brief Return the asa object description \return string, value is the description.- Specified by:
getDescriptionin interfaceAsaObject- Returns:
- String Returns a String
-
setDescription
Information provided by the PKI file:
\brief Set the description of the asa object \param description, value is the description to use for the object.- Specified by:
setDescriptionin interfaceAsaObject- Parameters:
description- Takes in a parameter of description
-
isReferenced
public boolean isReferenced()Information provided by the PKI file:
\brief Check to see if the asa object is being used by other classes \return bool, Value is true if the asa object is being used by other classes, false if not.- Specified by:
isReferencedin interfaceAsaObject- Returns:
- boolean Returns a boolean
-
addReferenceObject
Information provided by the PKI file:
\brief Any class that has reference to the asa object calls this function to confirm its association with the object \param reference, a unique string to identify which object that has association with the asa object- Specified by:
addReferenceObjectin interfaceAsaObject- Parameters:
reference- Takes in a parameter of reference
-
removeReferenceObject
Information provided by the PKI file:
\brief Any class that has reference to asa object calls this function to release its association with the object \param reference, a unique string to identify which object that has association with the asa object- Specified by:
removeReferenceObjectin interfaceAsaObject- Parameters:
reference- Takes in a parameter of reference
-
toString
Information provided by the PKI file:
\brief Return the string configuration of the asa object \return string, value is the string configuration of the asa object. -
getObjectServiceTypeString
Information provided by the PKI file:
\brief Return the string configuration for object-group of service type \return string, value is the string configuration for object-group of service type.- Specified by:
getObjectServiceTypeStringin interfaceAsaObject- Returns:
- String Returns a String
-